@motazmuhammad please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

Why add CMakeLists.txt for libxml? It's already provided upstream.

New port

1. You can create the yalantinglibs folder in vcpkg/ports/ and add portfile.cmake and vcpkg.json:

vcpkg/ports/testport/
    portfile.cmake
    vcpkg.json

Then run ./vcpkg install testport, if the installation is successful, it proves that there is no problem with the files you added.

2. Next, run ./vcpkg x-add-verison testport, the vcpkg/verisons/t-/testport.josn file will be added automatically, and a record will be added in vcpkg/verisons/baseline.json.

vcpkg/versions/
    t-/
        testport.josn (automatically generated)
    baseline.json (automatically add records)

The modification needs to meet the requirements: maintainer-guide

New port

1. You can create the yalantinglibs folder in vcpkg/ports/ and add portfile.cmake and vcpkg.json:

vcpkg/ports/testport/
    portfile.cmake
    vcpkg.json

Then run ./vcpkg install testport, if the installation is successful, it proves that there is no problem with the files you added.

2. Next, run ./vcpkg x-add-verison testport, the vcpkg/verisons/t-/testport.josn file will be added automatically, and a record will be added in vcpkg/verisons/baseline.json.

vcpkg/versions/
    t-/
        testport.josn (automatically generated)
    baseline.json (automatically add records)

The modification needs to meet the requirements: maintainer-guide

Reminder: The version file is missing. Please refer to: 39493/files.

@MonicaLiu0311 Thank you very much for all your insightful comments, I really appreciate them, I updated the fork with your suggested changes ( according to my best understanding). Please let me know if you have further comments, and please be patient with me).

Thank you again

When testing usage, the following error occurs:

E:\test\build>cmake --build .
MSBuild version 17.11.2+c078802d4 for .NET Framework

  1>Checking Build System
  Building Custom Rule E:/test/CMakeLists.txt
  test.cpp
C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.41.34120\include\variant(12): warning STL4038
: The contents of <variant> are available only with C++17 or later. [E:\test\build\main.vcxproj]
E:\openxlsx\installed\x64-windows\include\OpenXLSX\headers\XLXmlParser.hpp(50,10): error C1083: Cannot open include fil
e: 'external/pugixml/pugixml.hpp': No such file or directory [E:\test\build\main.vcxproj]
  (compiling source file '../test.cpp')

#include <iostream>
#include "OpenXLSX.hpp"
using namespace std;
int main()

{

cout << "Hello CMake." << endl;

return 0;

}

cmake_minimum_required (VERSION 3.8)
set(CMAKE_TOOLCHAIN_FILE "E:/openxlsx/scripts/buildsystems/vcpkg.cmake")
project ("test")
add_library (main "test.cpp")
find_package(OpenXLSX CONFIG REQUIRED)

target_link_libraries(main PRIVATE OpenXLSX::OpenXLSX)

When testing usage, the following error occurs:

E:\test\build>cmake --build .
MSBuild version 17.11.2+c078802d4 for .NET Framework

  1>Checking Build System
  Building Custom Rule E:/test/CMakeLists.txt
  test.cpp
C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.41.34120\include\variant(12): warning STL4038
: The contents of <variant> are available only with C++17 or later. [E:\test\build\main.vcxproj]
E:\openxlsx\installed\x64-windows\include\OpenXLSX\headers\XLXmlParser.hpp(50,10): error C1083: Cannot open include fil
e: 'external/pugixml/pugixml.hpp': No such file or directory [E:\test\build\main.vcxproj]
  (compiling source file '../test.cpp')

test.cpp
CMakeLists.txt

@MonicaLiu0311 Thank you very much that is fixed now. I have a question, if you dont mind please reply to them.

1. Right now I am using the head revision (master branch) as evident by the portfile REF master
   is that ok, I tried using REF "${VERSION}" however, the correct file was not picked up unless i make it
   REF "${VERSION}"
   REF "refs/tags/v${VERSION}"
   and if I do that, I need to change the SHA512 , do I need to create a seperate SHA for each version? I could not figure this out from the documents.

Thank you again for your patience. I hope to become a regular contributor to vcpkg

REF "refs/tags/v${VERSION}"

The regular expression for ${VERSION} matches only VERSION semantics. The upstream released version is "v0.3.2" not "0.3.2".

@MonicaLiu0311 Thank you very much for your comments, I added the changes you recommended. I, now, have two new questions.

1. Since I am using the v.0.3.2. now I had to add a patch for the code to compile on visual studio. This patch was actually later added to the master branch, but not to the latest release branch. Is that okay? or should the patch be added conditionally ( conditioned on the version number?)

2. in the context of patching, this patch is not needed for the master release, therefore, the user would not be able to use the master branch via vcpkg, is that okay?

Thank you for your patience

When testing usage, the following error occurs:

E:\test\build>cmake --build .
MSBuild version 17.11.2+c078802d4 for .NET Framework

  1>Checking Build System
  Building Custom Rule E:/test/CMakeLists.txt
  test.cpp
C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.41.34120\include\variant(12): warning STL4038
: The contents of <variant> are available only with C++17 or later. [E:\test\build\main.vcxproj]
E:\openxlsx\installed\x64-windows\include\OpenXLSX\headers\XLXmlParser.hpp(50,10): error C1083: Cannot open include fil
e: 'external/pugixml/pugixml.hpp': No such file or directory [E:\test\build\main.vcxproj]
  (compiling source file '../test.cpp')

test.cpp
CMakeLists.txt

This now works, but please note that to be able to use openxlsx in the cmakelists.txt file one has to add the following line set(CMAKE_CXX_STANDARD 17) as the some of the header files are dependent on c++17, should that be mentioned in the usage file in one way or the other?

1. Right now I am using the head revision (master branch) as evident by the portfile

    REF master

is that ok,

No. REF must identify a particular immutable release, tag or commit. master is a branch name, and the contents may change. (HEAD_REF may point to master.)

I tried using

   REF "${VERSION}" 

however, the correct file was not picked up unless i make it

  REF "refs/tags/v${VERSION}"

This indicates that the tags are named v<version>, and you should use

   REF "v${VERSION}"

and if I do that, I need to change the SHA512 , do I need to create a seperate SHA for each version?

Yes. The SHA512 is to verify the downloaded archive, and it is also used as an source asset cache key.

note that to be able to use openxlsx in the cmakelists.txt file one has to add the following line set(CMAKE_CXX_STANDARD 17) as the some of the header files are dependent on c++17, should that be mentioned in the usage file in one way or the other?

If there is exported CMake config, the C++17 requirement could be in the exported compile features.
https://cmake.org/cmake/help/latest/manual/cmake-compile-features.7.html#requiring-language-standards

@dg0yt thank you very much for your comments, I really appreciate all of them, I have replied to them to the best of my knowledge. Please accept my apologies for taking too much of your time, this is my first contribution to vcpkg

@MonicaLiu0311 Thank you very much for all your help and comments, now that all tests have passed is the pull request ok now?

@MonicaLiu0311 @dg0yt is there anything else I need to do?

The usage test passed on x64-windows (header files found):

openxlsx provides CMake targets:

  find_package(OpenXLSX CONFIG REQUIRED)
  target_link_libraries(main PRIVATE OpenXLSX::OpenXLSX)